Correctly encode structs without members #1968
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The JSON RPC API specification for 'eth_signTypedData_v4' does not explicitly state that the required struct 'EIP712Domain' has to define any members [1]. The current implementation cannot correctly encode such a structure, as it assumes that at least one member has been parsed and added to the struct's string representation. This commit refactors the struct encoding function such that it now accepts structures that does not define any members. [1] https://eips.ethereum.org/EIPS/eip-712#specification-of-the-eth_signtypeddata-json-rpc
Codecov Report
@@ Coverage Diff @@
## master #1968 +/- ##
============================================
- Coverage 68.49% 68.46% -0.03%
+ Complexity 3004 3003 -1
============================================
Files 488 488
Lines 12559 12556 -3
Branches 1637 1637
============================================
- Hits 8602 8597 -5
- Misses 3482 3483 +1
- Partials 475 476 +1
... and 1 file with indirect coverage changes 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The JSON RPC API specification for 'eth_signTypedData_v4' does not explicitly state that the required struct 'EIP712Domain' has to define any members [1]. The current implementation cannot correctly encode such a structure, as it assumes that at least one member has been parsed and added to the struct's string representation.
[1] https://eips.ethereum.org/EIPS/eip-712#specification-of-the-eth_signtypeddata-json-rpc
What does this PR do?
This commit refactors the struct encoding function such that it now accepts structures that does not define any members. This PR aims to resolve issue #1967.
Where should the reviewer start?
There's only one function changed. I've also gone ahead and added a new test.
Why is it needed?
This is needed to fully support the EIP-712 specification. Without it, web3j fails to properly handle valid types of structured data.